Получение списка подразделений верхнего уровня

Запрос позволяет получить информацию о подразделениях верхнего уровня.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/department

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
departments[] Список подразделений. Строка
departments[]._id Идентификатор подразделения. Строка
departments[].name Название подразделения. Строка
departments[].parent_id Идентификатор вышестоящего подразделения. Строка

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/client/233e725b0511459da7b38cb24f2d8fd7/department
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "departments": [
    { 
            "_id": "524ac5dcadf8410aa5f5217f44933970",
            "name": "Московский офис",
            "parent_id": null
    },
    {
            "_id": "233e725b0511459da7b38cb24f2d8fd7",
            "name": "Новосибирский офис",
            "parent_id": null

    }
  ] 
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
  • 404 — запрашиваемая запись не найдена.
Предыдущая
Получение информации о подразделении
Следующая
Получение списка дочерних подразделений